CustomGeometrySource

Custom Vector Source, allows using FeatureCollections.

CustomGeometrySource uses a coalescing model for frequent data updates targeting the same tile id, which means, that the in-progress request as well as the last scheduled request are guaranteed to finish. Any requests scheduled meanwhile can be canceled.

Constructors

Link copied to clipboard

Create a CustomGeometrySource

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard

Retrieve the source attribution.

Link copied to clipboard
open fun getId(): String

Retrieve the source id

Link copied to clipboard

Retrieve current maximum overscale factor for parent tiles.

Link copied to clipboard

Retrieve the minimum tile update interval, which is used to throttle the tile update network requests.

Link copied to clipboard

Retrieve current pre-fetching zoom delta.

Link copied to clipboard

Invalidate previously provided features within a given bounds at all zoom levels. Invoking this method will result in new requests to GeometryTileProvider for regions that contain, include, or intersect with the provided bounds.

Link copied to clipboard
fun invalidateTile(zoomLevel: Int, x: Int, y: Int)

Invalidate the geometry contents of a specific tile. Invoking this method will result in new requests to GeometryTileProvider for visible tiles.

Link copied to clipboard

Retrieve whether or not the fetched tiles for the given source should be stored in the local cache

Link copied to clipboard
fun querySourceFeatures(filter: Expression?): List<Feature>

Queries the source for features.

Link copied to clipboard
open fun setDetached()
Link copied to clipboard
open fun setMaxOverscaleFactorForParentTiles(@Nullable maxOverscaleFactor: Int?)

When a set of tiles for a current zoom level is being rendered and some of the ideal tiles that cover the screen are not yet loaded, parent tile could be used instead. This might introduce unwanted rendering side-effects, especially for raster tiles that are overscaled multiple times. This method sets the maximum limit for how much a parent tile can be overscaled.

Link copied to clipboard

Sets the minimum tile update interval, which is used to throttle the tile update network requests.

Link copied to clipboard
open fun setPrefetchZoomDelta(@Nullable delta: Int?)

Set the tile pre-fetching zoom delta for current source. Pre-fetching makes sure that a low-resolution tile at the (current_zoom_level - delta) is rendered as soon as possible at the expense of a little bandwidth. If delta has not been set or set to null, it will use the value in MapboxMap instance.

Link copied to clipboard
fun setTileData(zoomLevel: Int, x: Int, y: Int, data: FeatureCollection)

Set or update geometry contents of a specific tile. Use this method to update tiles for which GeometryTileProvider was previously invoked. This method can be called from background threads.

Link copied to clipboard
open fun setVolatile(value: Boolean)

Set a flag defining whether or not the fetched tiles for the given source should be stored in the local cache

Properties

Link copied to clipboard